﻿using System.Collections.Generic;
using Wedn.Core.Entity;

namespace Wedn.Interface.DAL
{
    /// <summary>
    /// 评论表操作类接口
    /// </summary>
    public interface IComment
    {
        #region 增加记录
        /// <summary>
        /// 向评论表中插入一行数据, 返回执行结果受影响行数
        /// </summary>
        /// <param name="comment">要增加的评论对象</param>
        /// <returns>执行结果受影响行数</returns>
        int Insert(Comment comment);
        #endregion

        #region 删除记录

        #region 删除一条数据
        /// <summary>
        /// 根据评论ID删除评论表中的评论记录, 返回执行结果受影响行数
        /// </summary>
        /// <param name="id">要删除的评论ID</param>
        /// <returns>执行结果受影响行数</returns>
        int Delete(int id);
        #endregion

        #region 删除多条数据
        /// <summary>
        /// 根据评论ID数组删除评论表中的评论记录, 返回执行结果受影响行数
        /// </summary>
        /// <param name="ids">要删除的评论ID数组</param>
        /// <returns>执行结果受影响行数</returns>
        int Delete(int[] ids);

        /// <summary>
        /// 根据评论状态删除评论表中的评论记录, 返回执行结果受影响行数
        /// </summary>
        /// <param name="status">要删除的评论的状态(0:待审核,1:审核通过,2:回收站,3:垃圾评论)</param>
        /// <returns>执行结果受影响行数</returns>
        int DeleteByStatus(int status);
        #endregion

        #endregion

        #region 更新记录

        #region 更新一个完整对象
        /// <summary>
        /// 更新一个完整评论对象, 返回执行结果受影响行数
        /// </summary>
        /// <param name="comment">更新的评论对象</param>
        /// <returns>执行结果受影响行数</returns>
        int UpdateComment(Comment comment);
        #endregion

        #region 更新字段

        /// <summary>
        /// 根据评论ID数组批量更新多个评论状态, 返回执行结果受影响行数
        /// </summary>
        /// <param name="ids">评论ID数组</param>
        /// <param name="status">更新的状态(0:待审核,1:审核通过,2:回收站,3:垃圾评论)</param>
        /// <returns>执行结果受影响行数</returns>
        int UpdateStatus(int[] ids, int status);

        #endregion

        #endregion

        #region 选取记录

        #region 选取表中主键最大值
        /// <summary>
        /// 获取表中主键最大值, 返回主键最大值
        /// </summary>
        /// <returns>主键最大值</returns>
        int SelectMaxId();
        #endregion

        #region 选取评论总数
        /// <summary>
        /// 选取评论总数
        /// </summary>
        /// <param name="where">选择条件(忽略则传入null或空值)(不能使用参数, 要使用参数化写重载)</param>
        /// <returns>总数</returns>
        int SelectCommentsCount(string where);
        #endregion

        #region 选取集合

        #region 获取所有评论集合
        /// <summary>
        /// 获取评论表中所有评论信息对象, 返回对象信息集合, 如果不存在则返回null
        /// </summary>
        /// <returns>所有评论对象信息集合</returns>
        List<Comment> SelectCommentList();
        #endregion

        #region 根据文章ID及页码从评论表中获取指定条数评论信息
        /// <summary>
        /// 根据文章ID及页码从评论表中获取指定条数评论信息, 返回评论信息对象集合, 如果不存在则返回null
        /// </summary>
        /// <param name="status">状态(0:待审核,1:审核通过,2:回收站,3:垃圾评论)(忽略该条件则传入-1)</param>
        /// <param name="postId">文章ID(忽略该条件则传入-1)</param>
        /// <param name="pageIndex">页码(忽略该条件则传入-1)</param>
        /// <param name="pageSize">显示条数(忽略该条件则传入-1)</param>
        /// <returns>符合条件评论信息对象集合</returns>
        List<Comment> SelectCommentList(int status,int postId, int pageIndex, int pageSize);
        #endregion

        #region 根据筛选条件从评论表中获取指定条数评论信息
        /// <summary>
        /// 根据筛选条件从评论表中获取指定条数评论信息, 返回评论信息对象集合
        /// 如果指定int类型参数传入-1, string传入null, 则表示忽略该检索条件
        /// 将默认按照发布时间降序排序, 返回评论信息对象集合, 不存在则返回NULL
        /// </summary>
        /// <param name="keyword">关键词(忽略该条件则传入null)</param>
        /// <param name="status">状态(0:待审核,1:审核通过,2:回收站,3:垃圾评论)(忽略该条件则传入-1)</param>
        /// <param name="pageSize">文章数目(忽略该条件则传入-1)</param>
        /// <param name="pageIndex">页码(忽略该条件则传入-1)</param>
        /// <param name="orderField">排序字段(忽略该条件则传入null)</param>
        /// <param name="order">排序方式(0:降序(desc)|1:升序(asc))(忽略该条件则传入-1)</param>
        /// <param name="recordCount">返回查询到的记录数</param>
        /// <returns>符合条件评论信息对象集合</returns>
        List<Comment> SelectCommentList(string keyword, int status, int pageIndex, int pageSize, string orderField, int order, out int recordCount);
        #endregion
        
        #endregion

        #region 根据评论ID获取评论对象
        /// <summary>
        /// 根据评论ID获取评论表中所有评论对象, 返回评论对象, 如果不存在则返回null
        /// </summary>
        /// <param name="id">评论ID</param>
        /// <returns>评论对象</returns>
        Comment SelectComment(int id);
        #endregion

        #endregion
    }
}
